Gets objects that have changed (created, modified, or deleted) since the last call.
HRESULT GetObjectChanges(ClassIDEnum classID, long actions, [out,retval]IADTObjects** objects);
GetObjectChanges(ClassIDEnum classID, long actions, [out,retval]IADTObjects* objects);
Sub GetObjectChanges(classID As ClassIDEnum, actions As long, objects As [out,retval]IADTObjects*)
|
Parameters |
Description |
|
[in]ClassIDEnum classID |
Optional CID of the objects to retrieve. Use CID_Unknown to get objects of all classes. |
|
[in]long actions |
Specifies the actions of interest. Set to any combination of the ObjectChangeTypeEnum values. |
|
[out,retval]IADTObjects** objects |
On return, contains a pointer to a collection containing the requested objects. |
GetObjectChanges goes through the addedObjects, deletedObjects, and modifiedObjects collections, as appropriate, looking for objects that match the requested action(s) and classID (if any).
All returned objects are removed from their respective collections. Therefore calling this method gives the caller all changes since the last time the method was called.
If you plan to use GetObjectChanges, you must make an initial call of the method to initialize the tracking mechanism--the API does not start tracking changes until the first call is received. The first call therefore will never return any objects.
GetObjectChanges only returns objects from a local cache; it does not make a call to the server. GetObjectChanges therefore relies on auto-refresh or a prior call to RefreshObjects to ensure that it has the most recent information.
|
adTempus API Reference version 3.0.0.0, revised 10/30/2008
|
